Методы взаимодействия с процессами BPM
/services/mdcamundaproxy/api/process/list
Метод получения BPM по идентификатору
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| filters | MdProcessFilter | |||
| pagination | MdRequestPagination |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ProcessDto[] | результат работы сервиса прикладной области в случае его успешного завершения | да | |
| error | ADSErrorSection | да | ||
| typeInfo | ADSTypeInfoSection | да |
/services/mdcamundaproxy/api/process/get
Метод получения BPM по идентификатору
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| key | integer (int64) | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | ProcessDto | да | ||
| error | ADSErrorSection | да | ||
| typeInfo | ADSTypeInfoSection | да |
/services/mdcamundaproxy/api/process/deployResource
Метод создания BPM
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| resourceName | string | нет | ||
| content | string | нет | ||
| deployResourceMeta | DeployResourceMeta |
Возвращаемые резу льтаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | MdDeployResourceProcessResult | да | ||
| error | ADSErrorSection | да | ||
| typeInfo | ADSTypeInfoSection | да |
/services/mdcamundaproxy/api/process/delete
Метод удаления определений BPM по ключу
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| key | integer (int64) | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | string | результат работы сервиса прикладной области в случае его успешного завершения | да | |
| error | ADSErrorSection | да | ||
| typeInfo | ADSTypeInfoSection | да |
/services/mdcamundaproxy/api/process/StartByKey
Метод запуска экземпляра BPM по заданным параметрам
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| processDefinitionKey | integer (int64) | нет | ||
| startBeforeElementId | string | нет | ||
| variables | object | нет |
Воз вращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | MdStartProcessResult | да | ||
| error | ADSErrorSection | да | ||
| typeInfo | ADSTypeInfoSection | да |
/services/mdcamundaproxy/api/process/StartByBpmnProcessId
Метод запуска экземпляра BPM по заданным параметрам
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| bpmnProcessId | string | нет | ||
| startBeforeElementId | string | нет | ||
| variables | object | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: application/json
OK
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | MdStartProcessResult | да | ||
| error | ADSErrorSection | да | ||
| typeInfo | ADSTypeInfoSection | да |